home *** CD-ROM | disk | FTP | other *** search
/ Software USA 5 #5 / Software USA Volume 5.05.iso / mac / Children / Bugs Bannis / Fantasoft.sea / Realmz 6.0.3 / Divinity DEMO / Divinity DEMO Manual.rsrc / TEXT_132.txt < prev    next >
Text File  |  1999-03-17  |  18KB  |  468 lines

  1.  
  2. Scripting Codes    1 through 29
  3.  
  4.  
  5. The following codes are used when scripting Action Points.  There are many codes, many with a number of options.  This allows you to create unique events in an infinite number of possibilities.  If you put the correct codes in sequence there is very little you can't do. 
  6.  
  7.  
  8. Code 1                            Display String
  9.  
  10. ID                                                                String Number to Display
  11.  
  12. Use:                                                Display‚Äôs string and waits for player to click mouse.
  13.  
  14. Options:                Negative ID will cause string to be displayed without             requiring player to click the mouse to continue.  This is commonly done to display a string just prior to executing a Code 3 in order to ask the player a question.
  15.  
  16. E-Codes:    None
  17.  
  18.  
  19.  
  20. Code 2                                    Battle
  21.  
  22. ID                                                                    Extra Codes ID
  23.  
  24. Use:                                                    Send party to combat.
  25.  
  26. Options:                    None
  27.  
  28. E-Codes:    1) Battle Number: Low Battle Number for Range Battle
  29.                                                                                 2) High Battle Number for Range Battle
  30.                                                                                 3) Sound to play before battle.  (Optional)
  31.                                                                                                     X-AP on Revived Losses.
  32.                                                                                 4) String to display before battle.  (Optional)
  33.                           5) Treasure award status / Party revive status.
  34.  
  35. 1)  If you want the player to do battle with a specific battle number, input the battle number desired in #1 and leave #2 blank.  If you want them to enter a random battle between a range of battles, enter the low battle range in #1 and the high range in #2.
  36.  
  37. Negative battle numbers will cause the party to be surprised by the opposing force.  This allows all enemies to move before party members.
  38.  
  39.  
  40. Example:  A low battle range of -4 and a high battle range of -8 would give them a random battle between 4 and 8 and always be surprised.
  41.  
  42. 2)  If you want to have the player enter combat in a random battle, enter the low range of battles in #1 and the high range of battles in #2.
  43.  
  44. 3)  Sound to be played as the player enters combat, enter the sound ID here.  This is optional and is not required.
  45.  
  46. 4)  String to be displayed before the player enters combat, enter the string ID here.  This is optional and is not required.
  47.  
  48. 5)  A value of 0 (Zero) here will award all items from enemies along with full Victory Points to the party when combat is over.
  49.  
  50. A value of 5 here will cause the player to receive Victory Points only.
  51. ----------------------------------------------------------------
  52. A value of 10 here will cause the party to be revived if they loose this battle.  They will all come back with 1 point of stamina.  They will not be awarded any victory points or treasure for this lost battle.
  53.  
  54. If you use the revive option then specify an X-AP to branch to in item 3.  DO NOT specify an optionl sound in battles you use the revive option on.
  55.  
  56.  
  57.  
  58. Code 3                                            Player Option
  59.  
  60. ID                                                                            Extra Codes ID
  61.  
  62. Use: Allows you to ask the player either a YES/NO question or you         can prompt the player with anything you like and branch             accordingly.
  63.  
  64. Options:                            None
  65.  
  66. E-Codes:                      1) 1 = Yes: Continue  0 = No: Continue
  67.                                                                                             2) 0 = Back Up, 1 = X-AP, 2 = Within Simple,
  68.                                                                                                             3 = Within Complex, 4 = Eliminate
  69.                                                                                             3) X-AP/Branch No. Of Encounter (0-3)
  70.                                 4) Prompt, left side (Optional)
  71.                                                                                             5) Prompt, right side (Optional)
  72.  
  73. 1)  A value of 1 here will cause the game to continue executing codes if the player clicks the YES or the Left option.  Otherwise, the game will branch to the locations specified in #2 and #3.  A value of 0 will cause the game to continue executing codes if the player clicks the NO or the Right option.  Otherwise the game will branch to the locations specified in #2 and #3. 
  74.  
  75. 2)  A value of 0 will cause the party to back up a pace on the map.  
  76. A value of 1 will cause the game to branch to an Extra Action Point.
  77. A value of 2 will cause the game to branch Within a Simple Encounter.
  78. A value of 3 will cause the game to branch to Within a Complex Encounter.
  79. A value of 4 will cause the game to eliminate this Action Point and stop executing the script.
  80.  
  81. 3)  The Extra Action Point, or encounter result no. to branch to.  You can either have it branch to an X-AP or have it branch within a simple or complex encounter.
  82.  
  83. 4)  A value of 0 will cause the game to display the standard YES / NO options for the user.  A value greater than zero will cause the game to display a phrase.  Example:  String ID.  20 could be written to say, ‚ÄúRescue the woman‚Äù  String ID.  21 could be written to say, ‚ÄúBack away‚Äù
  84. A prompt, Left side value of 20 and a prompt, Right side value of 21 would cause the game to display the options as read above instead of the Yes/No.
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92. 5)  Same as 4 above only for the right side of the question bar. 
  93.  
  94.  
  95.  
  96. Code 4                                Simple Encounter
  97.  
  98. ID                                                                Simple Encounter ID
  99.  
  100. Use:                                                Send party to a Simple Encounter.
  101.  
  102. Options:       None
  103.  
  104. E-Codes:       None
  105.  
  106.  
  107.  
  108. Code 5                                Complex Encounter
  109.  
  110. ID                                                                Complex Encounter ID
  111.  
  112. Use:                                                Send party to a Complex Encounter.
  113.  
  114. Options:                None
  115.  
  116. E-Codes:       None
  117.  
  118.  ¬†
  119.  
  120. Code 6                                            Load shop (See code 73 for more options)
  121.  
  122. ID                                                                            Shop ID
  123.  
  124. Use:                                                            Allow the party to use a shop/storage facility.
  125.  
  126. Options:                            A negative Shop ID will send the party directly to the shop.  If you give it a positive Shop ID it will activate the SHOP button.  Example:  A shop ID of -5 will send them to Shop 5 directly without having to click the SHOP button to enter the shop.
  127.  
  128. E-Codes:                      None
  129.  
  130. Script Tip:  If you edit the shop to have an inflation rate of 0%, the shop will act as a storage facility.  It will allow the party to store any item there and to later retrieve the items without cost.  The party cannot store items that have a magical charge as the game normally recharges any items sold to a shop.  To prevent FREE recharging, no chargeable items can be stored in a storage facility.
  131.  
  132. Note: See code 72 for more options
  133.  
  134. ¬† 
  135. Code 7                            Change Action Point Codes
  136.  
  137. ID                     Extra Codes ID
  138.  
  139. Use: Allows you to change the codes for an Action Point anywhere in the scenario.
  140.  
  141. Options:      None
  142.  
  143. E-Codes:  1) Land ID of Action Point codes to change.  -2  = Replace Simple
  144.                                                                                          Encounter Script, -3 = Replace Complex Encounter Script
  145.                         2) AP / Simple Enc ID / Complex Enc ID  To Modify
  146.                                                                         3) Extra Action Point ID that contains the new codes
  147.                         4) For AP replacement: 0 = Default to same land type,
  148.                                                                                         1= Land Level, 2 =    Dungeon Level
  149.                                                                         5) For Encounter Script Replacement: Result Code to Replace (0-3)
  150.                       
  151. Script Tip:    In effect, this allows you to replace the codes for any Action Point, Extra Action Point, Encounter Result Script with a different set of codes you have stored as an Extra Action Point.
  152.  
  153. For replacement of standard action points, all other aspects of the Action Point such as the percent chance and the location it will move the party to remains unchanged.
  154.  
  155.  
  156.  Code 8           Same as Other Action Point
  157.  
  158. ID                       Extra Codes ID
  159.  
  160. Use: This will allow you to assign codes to an Action Point by telling Realmz to use the same codes as another Action Point.
  161.  
  162. Options:        None
  163.  
  164. E-Codes:       1) Land ID of which Action Point codes you want to use.
  165.                           2) Action Point No. to use.
  166.  
  167. Script Tip:    This is more useful if you have many Action Points that all do the same thing but don't feel like coding them all.  This way you can change the way they all behave by just changing the script of the one Action Point they all refer to.
  168.  
  169.  
  170. Code 9          Play Sound
  171.  
  172. ID                      Sound ID of sound you wish to play.
  173.  
  174. Use:                  Allows you to play a sound.
  175.  
  176. Options:       A negative value for a sound ID will pause the execution of codes until the sound has finished playing.
  177.  
  178. E-Codes:       None
  179.  
  180. Script Tip:    To keep several sounds from running together you need to put in the ID as a negative.  That way you can play several sounds end to end.  Otherwise they will all play at the same time.
  181.  
  182. ¬† 
  183. Code 10          Give Treasure
  184.  
  185. ID                       Treasure ID
  186.  
  187. Use: Allows you to give treasure to the party.  The treasure will allow you to give gold, gems, jewelry, Victory Points and up to 20 items to the party.  The amount of gold, gems, jewelry and Victory Points is subject to change according to the difficulty level the player chooses.
  188.  
  189. Options:       None
  190.  
  191. E-Codes:       None
  192.  
  193.  ¬†
  194. Code 11         Give Victory Points
  195.  
  196. ID                      Amount of Victory Points to give.
  197.  
  198. Use: Allows you to give Victory Points to the party as a whole.  All party members that are conscious and not animated will share in an equal portion of the Victory Points.  This amount is subject to change according to the difficulty level the player chooses.
  199.  
  200. Options:       None
  201.  
  202. E-Codes:       None
  203.  
  204.  ¬†
  205. Code 12        Change Land Tile
  206.  
  207. ID                     Extra Codes ID
  208.  
  209. Use:                 Allows you to change one land icon to that of another. 
  210.  
  211. Options:       None
  212.  
  213. E-Codes:       1) Land/Dungeon level of tile to change
  214.                          2) X-Coordinate
  215.                          3) Y-Coordinate
  216.                          4) New Tile ID
  217.                          5) 0 = Land Level, 1 = Dungeons
  218.  
  219.  
  220. Code 13    Enable Action Point
  221.  
  222. ID                                                        Extra Codes ID
  223.  
  224. Use:                                        Use this to enable or disable an Action Point or to alter the percent chance that the party will encounter it.
  225.  
  226. Options:            None
  227.  
  228. E-Codes:   1) Land/Dungeon Level
  229.                                                                         2) Action Point Number
  230.                                                                         3) New % (Negative value = Disabled)
  231.                                                                         4) Action Point No. Low (Negative = Dungeon, Positive = Land)
  232.                                                                         5) Action Point No. High (Negative = Dungeon, Positive = Land)
  233.  
  234. ¬† 
  235. Code 14        Pick Characters
  236.  
  237. ID                     Number of characters to pick
  238.  
  239. Use: This will allow you to select characters then have specific actions that will affect only those who have been picked.
  240.  
  241. Options:      A negative value for ID will allow the player to only pick those PCs who are currently conscious or animated.
  242.  
  243. E-Codes:   None
  244.  
  245.  
  246.  Code 15                  Heal/Hurt Picked
  247.  
  248. ID                       Extra Codes ID
  249.  
  250. Use: Allows you to either heal or damage only those members who have been picked using a Code 14 or 30. (See Codes 14 and 30)  The formula for calculating damage/healing is Multiplier X (random amount from low-high).
  251.  
  252. Options:       None
  253.  
  254. E-Codes:      1) Multiplier   ( - Is Hurt )
  255.                                                                         2) Low Range
  256.                                                                         3) High Range
  257.                                                                         4) Sound ---Optional---
  258.                                                                         5) Message ---Optional---
  259.  
  260.  
  261.  Code 16          Heal/Hurt Party
  262.  
  263. ID                        Extra Codes ID
  264.  
  265. Use: This will allow you to either heal or damage all party members.  The formula for calculating damage/healing is: Multiplier X (random amount from low-high).
  266.  
  267. Options:           None
  268.  
  269. E-Codes:          1) Multiplier   ( - Is Hurt )
  270.                             2) Low Range
  271.                             3) High Range
  272.                             4) Sound ---Optional---
  273.                             5) Message ---Optional---
  274.  
  275. ¬† 
  276. Code 17        Cast Spell on Picked
  277.  
  278. ID                     Extra Codes ID
  279.  
  280. Use:                 This will allow you to cast a spell on those who have been picked using a Code 14 or 30. (See Code 14 Above and 30 below)
  281.  
  282. Options:       None
  283.  
  284. E-Codes:     1) Spell No. to Cast
  285.                            2) Power Level
  286.                            3) +/- % To DRVs Modifier
  287.                            4) 1 = No chance for PCs to DRVs.
  288.  
  289.      ¬†    
  290. Code 18           Cast Spell on Party
  291.  
  292. ID                        Extra Codes ID
  293.  
  294. Use:             This will allow you to cast a spell at all members of the party.
  295.  
  296. Options:         None
  297.  
  298. E-Codes:         1) Spell No. to Cast
  299.                             2) Power Level
  300.                             3) +/- % To DRVs Modifier
  301.                             4) 1 = No chance for PCs to DRVs.
  302.  
  303.  ¬†
  304. Code 19          Display Random String
  305.  
  306. ID                       Extra Codes ID
  307.  
  308. Use:             Allows you to display random strings in a range of strings.
  309.  
  310. Options:         None
  311.  
  312. E-Codes:         1) Low String Range Number
  313.                             2) High String Range Number
  314.  
  315.  ¬†
  316. Code 20         Teleport
  317.  
  318. ID                      Extra Codes ID
  319.  
  320. Use: Allows you to move the party to a new land level and X: Y: position.  If you teleport the party, with this code, onto a location that contains another Action Point, the new Action Point codes will begin to execute.  To teleport a party onto another location that contains an Action Point without those codes from being executed, use code 45.
  321.  
  322. Options:         None
  323.  
  324. E-Codes:         1) Land ID to Teleport To (-1 = No Change)
  325.                             2) X-Coordinate (-1 = No Change)
  326.                             3) Y-Coordinate (-1 = No Change)
  327.                             4) Sound   ---Optional---
  328.                             5) Message   ---Optional---
  329.  
  330. Script Tip :  At first glance this code may seem of no use.  Why not just use the Goto Level of an Action Point to move the party?  Well, it's simple.  You can use this in the scripts of Extra Action Points and Encounters as well.  That's why, my man.
  331.  
  332. Note:  A value of -1 in E-Code 1, 2 or 3 will tell the game NOT to make any change.  It will remain the current value in the game.  Example:  If you set E-Code to -1 and the party is on level 4 they will move to the new X: Y: position on Level 4.
  333.  
  334.  ¬†
  335. Code 21          Branch on Possession of Specific Item
  336.  
  337. ID                       Extra Codes ID
  338.  
  339. Use: Allows you to branch depending on whether or not someone in the party is in possession of a specific item.  CODE 38 is similar to this code, except it will allow you to branch around within a simple or Complex Encounter only.
  340.  
  341. Options:         None
  342.  
  343. E-Codes:         1) Item ID To Check For
  344.                             2) If Possessed, Branch To: 0 = X-AP, 1 = Simple Encounter, 
  345.                                 2 = Complex Encounter
  346.                             3) If Not Possessed, 0 = Branch as by Item 5, 1 = Continue Codes
  347.                                                                                                         2 = String & Exit
  348.                             4) X-AP / Encounter No. If Possessed.
  349.                             5) X-AP / Encounter No. / String ID If Not Possessed.
  350.  
  351.  ¬†
  352. Code 22           Alter Item Status
  353.  
  354. ID                        Extra Codes ID
  355.  
  356. Use: Allows you to change something about an item possessed by anyone in the party.
  357.  
  358. Options:          None
  359.  
  360. E-Codes:         1) Item ID To Alter
  361.                             2) Number of Items to Affect.
  362.                             3) To Do: 1 = Drop, 2 = Charge, 3 = Change Item to Item ID
  363.                             4) Charges To Add (- = Drain Charges)
  364.                             5) New Item ID
  365.  
  366. ¬† 
  367. Code 23          Alter Random Rectangle Information of a Land Level
  368.  
  369. ID                  Extra Codes ID
  370.  
  371. Use: Allows you to alter some aspects of a Random Rectangle.  Code 92 also allows you to alter some aspects of a Random Rectangle.
  372.  
  373. Options:  Code -23 works in an identical fashion as Code 23 only it will alter Random Rectangle information for a Dungeon Level.
  374.  
  375. E-Codes:      1) Land Level ID
  376.                             2) Rectangle Number To Alter
  377.                             3) New Times in 10,000
  378.                                                                                                      (0 = No Encounters, -1 = Use Invisible Encountner)
  379.                             4) New Battle Range Low (-1 = No Change)
  380.                             5) New Battle Range High (-1 = No Change)
  381.  
  382.  ¬†
  383. Code -23         Alter Random Rectangle Information for a Dungeon Level
  384.  
  385. ID                        Extra Codes ID
  386.  
  387. Use: Allows you to alter some aspects of a Random Rectangle.  Code 92 also allows you to alter some aspects of a Random Rectangle.
  388.  
  389. Options:  Code -23 works in an identical fashion as Code 23 only it will alter Random Rectangle information for Dungeon Level instead of a Land Level.
  390.  
  391. E-Codes:          1) Land Level ID
  392.                             2) Rectangle Number To Alter
  393.                             3) New Times in 10,000
  394.                                                                                                      (0 = No Encounters, -1 = Use Invisible Encountner)
  395.                             4) New Battle Range Low (-1 = No Change)
  396.                             5) New Battle Range High (-1 = No Change)
  397.  
  398.  ¬†
  399. Code 24        Exit Action Point And Keep Codes
  400.  
  401. ID                     None
  402.  
  403. Use: Allows you to exit the current Action Point and to have the codes saved.  If the party walks on the same spot, the codes will begin all over again.
  404.  
  405. Options:       None
  406.  
  407. E-Codes:       None
  408.  
  409. Script Tip: Code 24 is very common as the last code in an Action Point script.  If you wish a specific Action Point to stick around for the entire game, then you need to put a 24 as the last code.  This will cause it to be activated each and every time the party walks onto the Action point.
  410.  
  411. ¬† 
  412. Code 25         Exit and Erase Action Point
  413.  
  414. ID                      None
  415.  
  416. Use: Allows you to exit the current Action Point and to have the Action Points codes erased.  If the party walks on the same spot, nothing will happen.  This is the default action if the end of the codes have been reached and a CODE 24 has not been encountered.
  417.  
  418. Options:       None
  419.  
  420. E-Codes:       None
  421.  
  422.  
  423.  Code 26       Get Click
  424.  
  425. ID                     None
  426.  
  427. Use: This will put up a small window that requires the player to click the mouse to continue.  This code is somewhat obsolete now but I left it in so it would be backward compatible with some old scenario code.  It does have a use every now and then.
  428.  
  429. Options:       None
  430.  
  431. E-Codes:       None
  432.  
  433.  ¬†
  434. Code 27        Display Picture
  435.  
  436. ID                     Picture Resource ID to display
  437.  
  438. Use: Allows you to display a picture centered in the small tactical window.  The picture must have a unique ID and must be in the "Scenario" resource.  To add a pictures to your scenario you use the Picture Editor.  You can access the Picture Editor via a button in the "Scenario Data" dialog.  For more information on the Picture Editor see the chapter "Adding Pictures To Your Scenario"
  439.  
  440. Options:       None
  441.  
  442. E-Codes:       None
  443.  
  444.  ¬†
  445. Code 28        Redraw Screen
  446.  
  447. ID                    None
  448.  
  449. Use:  Redraws the screen.  The only really great use for this is to draw the game screen after you have displayed a picture.
  450.  
  451. Options:       None
  452.  
  453. E-Codes:       None
  454.  
  455.  ¬†
  456. Code 29         Give / Display Map
  457.  
  458. ID                      Map Number to give or display.
  459.  
  460. Use:     Allows you to give the player any map from number 0 through 19.  Map No. 0 is automatically given to the player as they begin an adventure.
  461.  
  462. Options:       Using a negative Map ID will display the map right away.  Example:  Lets say you want the part to view a map as soon as they walk on an AP.  Lets say this is Map No. 5.  A script of "Code 29 ID -5" will give the party map 5 and display it right away.
  463.  
  464. E-Codes:       None
  465.  
  466.  
  467.   
  468.